<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>pyzy: PyZy Namespace Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">pyzy
   &#160;<span id="projectnumber">0.0.8</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="namespaces.html"><span>Namespace&#160;List</span></a></li>
      <li><a href="namespacemembers.html"><span>Namespace&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">PyZy Namespace Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Converts Pinyin / Bopomofo characters to phrases.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPyZy_1_1Candidate.html">Candidate</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains a candidate data.  <a href="structPyZy_1_1Candidate.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPyZy_1_1InputContext.html">InputContext</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Pinyin / Bopomofo conversion class.  <a href="classPyZy_1_1InputContext.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPyZy_1_1Variant.html">Variant</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classPyZy_1_1Variant.html" title="Variant class to handle various type of value.">Variant</a> class to handle various type of value.  <a href="classPyZy_1_1Variant.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePyZy.html#a0c4a12670dfb7a455ba9f8a3a732852a">CandidateType</a> { <a class="el" href="namespacePyZy.html#a0c4a12670dfb7a455ba9f8a3a732852aad640459d46bebca4386e39068f4b4312">NORMAL_PHRASE</a>, 
<a class="el" href="namespacePyZy.html#a0c4a12670dfb7a455ba9f8a3a732852aa10efcd90fed780e1543ba6e20a37869d">USER_PHRASE</a>, 
<a class="el" href="namespacePyZy.html#a0c4a12670dfb7a455ba9f8a3a732852aabadeae4b5cde1f53da3c40a98bef9923">SPECIAL_PHRASE</a>
 }</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">An enum to represent a candidate type.  <a href="namespacePyZy.html#a0c4a12670dfb7a455ba9f8a3a732852a">More...</a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Converts Pinyin / Bopomofo characters to phrases. </p>
<p>Takes PinYin / Bopomofo characters and convert it to phrases. This class provides following methods.</p>
<ul>
<li>Context manipulation methods like insert(), removeCharBefore(), ...</li>
<li>Getters of input / preedit / candidates / cursor / ...</li>
<li>Getters / Setters of some conversion options.</li>
</ul>
<p>To use this class, you should call <a class="el" href="classPyZy_1_1InputContext.html#a78cce1032342f094be615ec0dd3851cf" title="Initializes a InputContext class.">InputContext::init()</a> at first and <a class="el" href="classPyZy_1_1InputContext.html#ac197a8cd66bc0b85dd42339f5b283e08" title="Finalizes a InputContext class.">InputContext::finalize()</a> at last. </p>
</div><hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a0c4a12670dfb7a455ba9f8a3a732852a"></a><!-- doxytag: member="PyZy::CandidateType" ref="a0c4a12670dfb7a455ba9f8a3a732852a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="namespacePyZy.html#a0c4a12670dfb7a455ba9f8a3a732852a">PyZy::CandidateType</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>An enum to represent a candidate type. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a0c4a12670dfb7a455ba9f8a3a732852aad640459d46bebca4386e39068f4b4312"></a><!-- doxytag: member="NORMAL_PHRASE" ref="a0c4a12670dfb7a455ba9f8a3a732852aad640459d46bebca4386e39068f4b4312" args="" -->NORMAL_PHRASE</em>&nbsp;</td><td>
<p><a class="el" href="structPyZy_1_1Candidate.html" title="Contains a candidate data.">Candidate</a> from a system dictionary. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a0c4a12670dfb7a455ba9f8a3a732852aa10efcd90fed780e1543ba6e20a37869d"></a><!-- doxytag: member="USER_PHRASE" ref="a0c4a12670dfb7a455ba9f8a3a732852aa10efcd90fed780e1543ba6e20a37869d" args="" -->USER_PHRASE</em>&nbsp;</td><td>
<p><a class="el" href="structPyZy_1_1Candidate.html" title="Contains a candidate data.">Candidate</a> from a user input. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a0c4a12670dfb7a455ba9f8a3a732852aabadeae4b5cde1f53da3c40a98bef9923"></a><!-- doxytag: member="SPECIAL_PHRASE" ref="a0c4a12670dfb7a455ba9f8a3a732852aabadeae4b5cde1f53da3c40a98bef9923" args="" -->SPECIAL_PHRASE</em>&nbsp;</td><td>
<p><a class="el" href="structPyZy_1_1Candidate.html" title="Contains a candidate data.">Candidate</a> from a special phrase. </p>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Wed Aug 1 2012 16:45:23 for pyzy by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
